Repository navigation
docs: add bilingual beginner guide + reflect the 已注册因子 rename - #24
Merged
Merged
Conversation
Promote the illustrated Chinese getting-started guide (docs/getting_started_zh.md) to a tracked doc: end-to-end first-run walkthrough with 7 flow diagrams, metric中英对照, and a section on switching the LLM provider from the Web UI. Update its tab reference to the renamed 已注册因子 label, drop it from .dockerignore so it ships with the other docs/, and link it from the README docs list.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Promotes the illustrated Chinese beginner guide to a tracked doc and links it from the README.
docs/getting_started_zh.mdis an end-to-end first-run walkthrough for a newcomer with zero background: what the tool does, 7 core terms, install (Docker / venv), first launch + control token, a UI tour, mining a first factor, and — importantly — a "what actually happens after you click 开始研究" section (parse → confirm → compute → report, whether the LLM was called, where data comes from, how metrics and the backtest read). It ships 7 flow diagrams and an English/Chinese metric glossary.This PR:
docs/(previously an untracked local draft);.dockerignoreso it ships in the image alongside the otherdocs/;Desensitization
Scanned before tracking — no API keys, no control tokens, no absolute local paths, and no internal-attribution or platform-account material.
release_safety_scan.pypasses on 278 public files (the guide included) andtests/test_release_cleanliness.pyis green.